home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / EDITORS / WF310C.ZIP;1 / WF310DOC.ZIP / DOCS / WF.014 < prev    next >
Encoding:
Text File  |  1992-01-31  |  11.1 KB  |  326 lines
  1. .f3                              - # -              Chapter 14 - TOC
  2. .rm70
  3. .tc.cp8
  4. .tc
  5. .tc 14. TABLE OF CONTENTS .................................#
  6. CHAPTER 14   TABLE OF CONTENTS
  7.  
  8. .imTable Of Contents
  9. Many documents you produce will require a table of contents. This can
  10. be achieved by identifying the table of contents entries, and
  11. executing a Generate Table Of Contents command (Ctrl F5). The table of
  12. contents files have the same name as the file you are generating for,
  13. but have the extension .TOC for the main one and the extensions .TO1
  14. up to .TO9 for the ancillary ones. Only those files you request will
  15. be produced.
  16.  
  17. .imDot Commands
  18. .ixDot Commands;  .FI - include file
  19. Table of contents files can be included in your document by use if the
  20. file include (.FI) dot command, and if so included, will be printed
  21. when you print the document. However, if you change the document, you
  22. will need to re-create the table of contents files, since this is not
  23. done automatically.
  24.  
  25. Level Numbers can be generated automatically if you wish, or you can
  26. put them in yourself. Automatic level numbers can be numbers, letters
  27. or Roman numerals.
  28.  
  29. .tc    Identifying Table of Contents Entries ..............#
  30. .ixTable Of Contents;Table Of Contents
  31. .ixTable Of Contents;   Identifying entries for
  32. Identifying Table of Contents Entries
  33.  
  34. .ixDot Commands;  .TC - Table of Contents
  35. Before you can generate a table of contents, you need to identify each
  36. entry that you want in the table of contents. This is done with the
  37. .TC dot command. Separate each entry from the dot command by at least
  38. one space. If you wish to include the page number, merely put the
  39. character # in the line where you wish it to print. You can include
  40. special print control functions and characters for special effects
  41. during printing. To indent an entry in the table of contents, just put
  42. extra spaces after the TC
  43.  
  44.   for example:
  45.  
  46.     .TC INTRODUCTION.............................#
  47.  
  48.     .TC      Part 1..............................#
  49.  
  50.     Your table of contents entries will look like this:
  51.  
  52.     INTRODUCTION.............................1
  53.          Part 1..............................2
  54.  
  55.  
  56. If you follow the dot command immediately by a number 1 to 9, the
  57. table of contents line will not be written to the .TOC file, but
  58. instead to a separate file with the extension .TO1 to .TO9 depending
  59. on the digit. This allows you more flexibility in generating tables of
  60. contents, for example a separate list of tables, a separate list of
  61. illustrations and so on.
  62.  
  63. .CP10
  64.   for example:
  65.  
  66.     .TC1 figure 1.1 Sales vs Expenditure ... #
  67.     .tc2 table 1.1 Sales vs Expenditure  ... #
  68.  
  69.   will produce in file.TO1 the line
  70.  
  71.        figure 1.1 Sales vs Expenditure ... 4
  72.  
  73.   and in file.TO2 the line
  74.  
  75.        table 1.1 Sales vs Expenditure  ... 4
  76.  
  77.   assuming that the page number is 4.
  78.  
  79. .ixTable Of Contents;Table Of Contents
  80. Word Fugue will gather all the entries for a numbered .TC command and
  81. place them into separate files. All these files have the same name as
  82. the original document, but the extension is set to a numbered
  83. extension: .TO1 , .TO2 and so on.
  84.  
  85. .tc    Automatic Level Numbering ..........................#
  86. .ixTable Of Contents;   Automatic Level Numbering
  87. Automatic Level Numbering
  88.  
  89. Level numbers can be generated automatically by use of the @L print
  90. function. You can have up to 9 different level numbers, in differing
  91. types and styles. This is discussed more fully below. You place the
  92. level number in brackets : {.@L1} for level 1 to {.@L9} for level 9.
  93. They will be expanded at printing or TOC generation, depending whether
  94. they are in the text body or the .TC lines.
  95.  
  96. .tc       Style of Numbering ..............................#
  97. .ixTable Of Contents;   Style of Numbering
  98.   Style of Numbering
  99.  
  100.   Style can be any of Office, Decimal (default), or Nodot.
  101.  
  102.   Office prints only one number for each level, followed by a dot.
  103.   Thus:
  104.  
  105.          {.@L1}
  106.            {.@L2}
  107.              {.@L3}
  108.  
  109.            gives
  110.            1.
  111.              1.
  112.                1.
  113.  
  114.   NoDot is similar to Office, except that the dot (.) is not printed.
  115.   Thus:
  116.  
  117.          {.@L1}
  118.            {.@L2}
  119.              {.@L3}
  120.  
  121.            gives
  122.            1
  123.              1
  124.                1
  125.  
  126. .CP9
  127.   Decimal produces all levels separated by dots (.)
  128.   Thus:
  129.  
  130.          {.@L1}
  131.            {.@L2}
  132.               {.@L3}
  133.  
  134.             gives
  135.  
  136.          1.
  137.            1.1.
  138.               1.1.1.
  139.  
  140.  
  141. .ixTable Of Contents;Table Of Contents
  142. .ixDot Commands;  .TS - TOC number Style
  143.   You set this with the .TS command
  144.  
  145.          .TS O   for  Office
  146.       or .TS D   for  Decimal
  147.       or .TS N   for  Nodot
  148.  
  149.   The style you last set remains in effect for all level numbers until
  150.   you change it. Thus if you wish to have decimal numbering for the
  151.   first three levels, and Office numbering for the remainder, you will
  152.   need to use .TS D when you start, .TS O when you reach level 4, and
  153.   .TS D when you return to a level lower than 4. You will need to
  154.   continue toggling the style throughout the document.
  155.  
  156. .tc       Types of Numbering ..............................#
  157. .ixTable Of Contents;   Type of Numbering
  158. .ixDot Commands;  .TL - Type of Numbering
  159.   Types of Numbering
  160.  
  161.   Each level can have its own type of numbering, independent of all
  162.   the other levels. The available types of numbering are:-
  163.  
  164.     R      Roman uppercase       eg   III.
  165.     r      roman lowercase       eg   iii.
  166.     N or n Numeric (default)     eg   3.
  167.     A      Alphabetic uppercase  eg   C.
  168.     a      alphabetic lowercase  eg   c.
  169.  
  170.   You set this with the .TL command:
  171.  
  172.               .TLn x
  173.                         where n is 1 to 9 (the level)
  174.                               x is R,r,N,n,A,a (as above)
  175.  
  176.   NOTE These letters are case sensitive, so that r (lowercase) will
  177.        give lowercase Roman, while R (uppercase) will give uppercase
  178.        Roman.
  179.  
  180. .tc       Set Start Numbers ...............................#
  181. .ixTable Of Contents;   Set Start numbers
  182.   Set Start Numbers
  183.  
  184.   Each level defaults to starting at number 1. However, you can start
  185.   each level at a different number, eg if you have divided your
  186.   document up into different parts, and only want to print a part of
  187.   it.
  188.  
  189.   Note that referencing a lower numbered level will automatically
  190.   reset all higher numbered levels to 1.
  191.  
  192.   For alphas, use the equivalent number eg a = 1, b=2, z=26 etc. The
  193.   level number is always stored internally as a number, and is
  194.   converted on printing to the appropriate text.
  195.  
  196. .CP5
  197. .ixDot Commands;  .TN - Start TOC number
  198. .ixTable Of Contents;Table Of Contents
  199.   You set this with .TN command:
  200.  
  201.             .TNn  i
  202.                        where n is 1 to 9 (the level)
  203.                              i is the start number
  204.  
  205. .tc       Space Reserved For Numbers.......................#
  206. .ixTable Of Contents;   Space reserved for numbers (.TW)
  207.   Space Reserved For Numbers
  208.  
  209.   By default, Word Fugue reserves 8 characters in which to fit the
  210.   style numbers is generates. This means that each number generated
  211.   will be padded out to 8 characters if it is shorter. Sequences
  212.   longer than 8 characters are left as is.
  213.  
  214.   Substitution of the style number deletes the characters that were
  215.   used to generate the number, and then inserts the generated style
  216.   number, padded to 8 characters if it were shorter.
  217.  
  218. .ixDot Commands;  .TW - Space reserved for TOC number
  219.   You can change the amount of space reserved if you wish. You do this
  220.   by means of the .TW command.
  221.  
  222.             .TW n
  223.                        where n is the number of characters to reserve
  224.                        (from 1 to 25 characters). Subsequent style
  225.                        numbers will be padded out to the length
  226.                        specified.
  227.  
  228. .tc       Examples ........................................#
  229.   Examples
  230.  
  231.      OFFICE
  232.  
  233.           .TS Office
  234.           .TL2 r
  235.           .tl3 a
  236.              {.@L1} this is level 1
  237.                {.@L2} this is level 2
  238.                   ({.@L3}) this is level 3
  239.  
  240.                     produces
  241.  
  242.              1. this is level 1
  243.                i. this is level 2
  244.                   (a.)  this is level 3
  245.  
  246.  
  247. .CP14
  248.      NODOT
  249.  
  250.           .TS Nodot
  251.           .TL2 r
  252.           .tl3 a
  253.              {.@L1} this is level 1
  254.                {.@L2} this is level 2
  255.                   ({.@L3}) this is level 3
  256.  
  257.                     produces
  258.  
  259.              1 this is level 1
  260.                i this is level 2
  261.                   (a) this is level 3
  262.  
  263.  
  264. .CP8
  265.      DECIMAL
  266.  
  267.           .TS Decimal
  268.           .TL2 r
  269.           .tl3 a
  270.              {.@L1} this is level 1
  271.                {.@L2} this is level 2
  272.                   ({.@L3}) this is level 3
  273.  
  274.                     produces
  275.  
  276.              1. this is level 1
  277.                1.i. this is level 2
  278.                   (1.i.a.) this is level 3
  279.  
  280.  
  281. .ixTable Of Contents;Table Of Contents
  282.   Embed the commands in the .TC lines for the correct numbers to
  283.   appear in table of contents.
  284.  
  285.              .tc {.@L1} this is level 1 ................... #
  286.              {.@L1} this is level 1
  287.              .tc  {.@L2} this is level 2 .................. #
  288.                {.@L2} this is level 2
  289.              .tc     ({.@L3}) this is level 3 ............. #
  290.                   ({.@L3}) this is level 3
  291.  
  292.  
  293. .ixTIPS;   printing a print function name
  294. TIP - How did we get the print functions themselves to print here,
  295.       rather than the results of their evaluation? Simple, we placed 2
  296.       print control characters between the "{" and the "." like this
  297.       {<B><B>.      where <B> stands for the ctrl B character.
  298.  
  299. .CP5
  300. .tc    Producing a Table of Contents ......................#
  301. .ixTable Of Contents;   Generating
  302. Producing a Table of Contents
  303.  
  304. To produce the table of contents, enter the command Ctrl F5. You will
  305. be prompted for the name of the file for which to generate the TOC.
  306. Enter the name of the file. Note if you are working on the file,
  307. please save it first so that the up to date version is used.
  308. Production of tables of contents happen in foreground, so you will not
  309. be able to do any editing while this happens. However, table of
  310. contents generation usually takes no more than a few seconds.
  311.  
  312. Word Fugue will gather all the entries for a numbered .TC command and
  313. place them into separate files. All these files have the same name as
  314. the original document, but the extension is set to a numbered
  315. extension: .TO1 , .TO2 and so on.
  316.  
  317. These files should be included in your document via the .FI command.
  318.  
  319. .ixTable Of Contents;Table Of Contents
  320. .ixTIPS;   Tables of Contents for Books
  321. TIP - if you are writing a book or similar, with several chapters, set
  322.       each chapter up as a separate file, and create a master file
  323.       that includes each chapter, table of contents & index file by
  324.       use of .FI commands. Generate the table of contents for the top
  325.       level file, and all lower level files will be included.
  326.